Night Owl 6/Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso/015a/obscd.zip/OCD.DOC

Text File | 1991-09-23 | 26KB | 755 lines

@PL 60
@PO 3
@MB 2
@MT 2
@FM 0
@HM 0
@OP




                            Obs Toolkit (TM)

                             ObsCD component

                               User Manual





                              A DOS toolkit

                    providing ultimate capability to

                      Command Line and Batch users






                           _______
                      ____|__     |                (R)
                   --|       |    |-------------------
                     |   ____|__  |  Association of
                     |  |       |_|  Shareware
                     |__|   o   |    Professionals
                   -----|   |   |---------------------
                        |___|___|    MEMBER






                             Contrails, Inc.
                              P.O. Box 2759
                          Lompoc, CA 93438-2759

                             CIS 71121,2426



                           Program created by
                            Keith E. Robbins



                           Copyright (c) 1991
                           by Contrails, Inc.
                           All rights reserved
@PA
                               ObsCD (OCD)
                               -----------

  Description:
     ObsCD (OCD) is a utility that allows you to move between directories
     with ease. CD was O.K. when a disk was only 5 meg, but now you
     probably have more that 100 meg of finely structured directories.
     Using a computer is hard enough (really its easy), without having to
     remember exactly where you put everything.

     ObsCD maintains a HotDir file of directories on your disk(s), so
     that you can go there with one simple command.

     ObsCD uses sophisticated pattern matching logic, so that it tries
     very hard to figure out which directory you want to change to.

     In addition ObsCD can Push and Pop directories. (A directory stack
     must be installed for these operations.)

     ObsCD tries to limit its assumptions about how you want it to
     operate, so there are options to configure its operation.

@cp 2
  Usage:
     OCD [options] [SmartPath][directory]

@cp 5
     If the directory name is preceded by an asterisk '*' (e.g., *STRING),
     then a substring match will be performed. Any directory that
     contains the string which follows the asterisk will be selected. You
     can reissue the same command to go from the current directory to the
     next matching directory.

@cp 5
     If the directory name contains any question marks '?' (e.g.
     budget??), then only directory names that match the verbatim text
     exactly, and have place holders for the '?'s will be selected. Once
     again, you can reissue the same command to go from the current
     directory, to the next matching directory.

@cp 9
     You can select a fixed path by specifying the directory name like
     the following (CPROGS\LF). This will cause a fuzzy match on "CPROGS"
     but requires an absolute match on "LF". The concept can be extended
     further to include matches such as (TURBO\TC\CPROGS), will select
     that CPROGS directory over any other CPROGS directories. NOTE: The
     primary directory (e.g., CPROGS in the first example, and TURBO in
     the second) must be located in the HotDir file. If the directory is
     not in the HotDir file, or was excluded, then OCD will not be able
     to locate the directory.

@cp 3
  Options:
     /Basedisk - Drive letter of lowest hard drive in system
        Usage: OCD /BASEDISK drive

@cp 4
        This option informs OCD that this system is not configured with
        the lowest hard drive as drive C:. The basedisk defaults to C:
        Use this option to inform OCD that the system has more than two
        floppies, or that the hard disk is drive B:

@cp 2
     /Change - Change to dir
        Usage: OCD /MKDIR /CHANGE newdir

@cp 5
        This option directs OCD to change to the newly created directory.
        It is still necessary to use /DISK if you want the current
        location moved there across disks; otherwise, the current
        directory for the specified disk will be changed. Requires
        (/MKDIR) to create the directory.

@cp 4
     /DIsk - Allow a change of drives
        This option permits OCD to change disks, when trying to satisfy
        your request for a directory. If this option is absent, OCD will
        not leave the current disk.

@cp 2
     /DRives - Use these drives during the /READ operation
        Usage OCD /READ /DRIVES drives

@cp 3
        This option restricts the drives that OCD will use during the
        /READ operation. This option is good for eliminating shadow
        disks.

@cp 2
        The next parameter must be a collection of drive letters (e.g.
        ABCDEFG).

        This option requires the /READ option.

        Note: This option will override the /LAST drive.

@cp 3
     /ECho - Report the directory changed to
        This will, upon every location change, echo to the console, the
        directory that was selected, and changed to.

@cp 4
        TIP:
           Use OCD /ECHO if you don't keep your current working directory
           in your prompt. This option will enable you to determine your
           current location after the move without asking.

@cp 5
     /Force - Force the directory push
        This option will cause the /PUSH to place the current directory
        onto the DirStack even if it would duplicate the top most entry.
        This option is useful in batch files, to ensure that you return
        the user to there originating position.

        This option requires /PUSH.

@cp 5
        TIP:
           When changing directories within batch files, be sure to
           restore the users original environment. ObsCD can help. Use
           the following procedure (a minimum DirStack of size 2 is
           required):
@cp 6
             OCD /PUSH /FORCE
             drive:
             OCD /PUSH /FORCE \directory
             REM invoke program
             OCD /POP
             OCD /POP

@cp 4
     /LAst - Do not consider drives beyond during the /READ operation
        Usage: OCD /READ /LAST drive

        All drives beyond the stated last drives will be ignored during
        the /READ operation. This option is good for eliminating RAM
        disks, and SUBSTituted drives.

@cp 2
        The next parameter must be a drive ID (e.g., F:). The colon is
        optional.

        This option required the /READ option.

@cp 4
     /LIst - Report the directory stack and default directories
        This option allows you to List the DirStack. The entries will be
        numbered from top of stack (1:) to the bottom of stack (4:).
        These are the locations that you can POP to.

@cp 5
        In addition, this command also reports the current default
        directory for each hard-drive on your system. These directories
        can be used by all DOS software, and most third party software
        (Obs Toolkit included) simply by specifying the Drive name (e.g.
        C:).

@cp 4
        Note:
           If the /PUSH option is combined with /LIST then the /PUSH will
           be ignored. Otherwise, the stack may have been modified when
           you requested a listing.

@cp 2
     /MKdir (MD) - Make directory
        Usage: OCD /MKDIR newdir

@cp 3
        This option allows you to make a new directory, and update the
        HotDir file at the same time. If you want to change to the newly
        created directory, and use the (/CHANGE) option also.

@cp 2
     /POp [n] - Return to a previously pushed directory.
        This option moves you to the 'n'th location on the stack.

        A DirStack must be installed for this option to be available.

@cp 3
        Note:
           If the pop operation exceeds the stack depth, then a warning
           message will be displayed, and no operation will occur.

@cp 5
     /PUsh - Push location onto stack
        Place the current disk and directory (location) onto the
        DirStack. If the current directory, is already at the top of the
        DirStack, then it is not pushed. This is to conserve the precious
        DirStack space. Use /FORCE to duplicate the DirStack top.

@cp 2
        If a directory is supplied, then push the current directory, and
        change to the new directory.

@cp 3
        Note:
           If the PUSH option is combined with LIST then the PUSH will be
           ignored.

@cp 2
           The default DirStack is four (4) locations deep, but this can
           be specified when installing ObsRes.

@cp 2
           Whenever the stack overflows on a push, then the bottom of the
           stack (oldest entry) will be pushed off without warning.

@cp 4
     /REad - Read the HotDir file
        OCD uses a Hot Directory file, which it places on your basedisk
        drive. Refer to /BASEDISK for information on the basedisk. Floppy
        disks are supported by HotDirs always.

@cp 2
        This option creates the Hot Directory file on the lowest
        addressable hard drive (usually C:). The filename is OBSCD.NDX.
        You cannot issue a /READ on a drive less that the /BASEDISK.

@cp 3
        In order to quickly determine which directory you want to go to,
        this file is consulted. OCD will function without this file, but
        Hot Directories will not be supported.

        This command may take a short while.

        This file must be explicitly created.

@cp 2
     /RMdir (RD) - Remove directory
        Usage: OCD /RMDIR emptydir

@cp 2
        This option instructs OCD to remove a directory, and eliminate it
        from the HotDir file.

@cp 3
     /Scan - Scan disk for directory
        This option allows HotDir capability on a disk/directory that was
        previously eXcluded. The information is not stored in the HotDir
        file.

@cp 3
     /UP [n] - Move UP the path
        This option moves you up 'n' sub-directories from the current
        path.

@cp 4
     /UPDate - Update the HotDir file when necessary
        This option maintains the HotDir file on the fly, without
        performing a /READ operation. Use of this option is must faster
        than re-reading the entire directory structure.

@cp 2
        When changing to a directory that was deleted, this option
        removes the deleted directory from the HotDir file.

@cp 3
        When changing from a directory that does not exist in the HotDir
        file, this option adds the current directory, and its parents if
        necessary, to the HotDir file.

@cp 4
        This command is provided so that you can easily update the HotDir
        file after using a third party software installation, that
        created its own directories, or after a cleanup that moved or
        deleted directories.

@cp 4
        TIP:
           If you set your CD command to default to /UPDATE the HotDir
           file will remain fairly much up-to-date, without having to
           resort to a /READ operation.

@cp 2
     /eXclude - Exclude directory from the HotDir file
        Usage: OCD /READ { /EXCLUDE dirname }

@cp 3
        This option permits disk branches to be eliminated from the
        HotDir file. Once a branch has been eliminated, it will not be
        updated. Up to 8 excluded branches may be specified.

        This option requires the /READ option.

@cp 3
        Note:
           To add the branch back into the HotDir file a /READ operation
           must be performed.

@cp 5
  TIPS:
     If you use a basedisk other that C:, then use recursive aliases and
     define OCD to be OCD /BASEDISK ?: where ? is your lowest addressable
     hard drive (e.g., ALIAS ocd OCD /BASEDISK D:). This will ensure that
     OCD always uses the correct basedisk.

@cp 4
     Define the following commands:
        C>ALIAS cd OCD /PUSH
          This will operate like DOS's CD, but will stack Hot Directories
          and enable returns.

@cp 2
        C>ALIAS cdd OCD /DISK /PUSH
          This will allow you to change directories and disks with CDD.

@cp 3
        C>ALIAS sw OCD /PUSH /POP
          This will allow you to switch between the current directory and
          the directory on the top of the DirStack.

@cp 4
        C>ALIAS md OCD /MKDIR
        C>ALIAS rd OCD /RMDIR
          These commands will update the HotDir file whenever you create
          or remove a directory.

@cp 2
        C>ALIAS pop OCD /POP
          This will allow you to move back to a previous location.

@cp 2
        C>ALIAS up OCD /PUSH /UP
          This will allow you to move up the directory branch.

@cp 3
        C>ALIAS list OCD /LIST
           This will allow you to list the current DirStack, and drive
           default directories.

@cp 3
           When using the directory stack with MultiFile, and ListFiles,
           you can easily determine which SmartPath that you want to
           reference.

@cp 3
     Use recursive aliases, and define OCD to be OCD /UPDATE. This will
     enable ObsCD to update the HotDir file whenever it detects that a
     new directory was created, or an existing directory was deleted.

@cp 3
     Use a prompt that contains the directory pathname, or direct OCD to
     echo (OCD /ECHO) its actions. If you don't you may not know where
     you are.

@cp 2
        C>prompt $p$g - The prompt will tell you where you are at all
                        times.

@cp 4
  Examples:
     C>OCD
       This will report the current directory.

@cp 3
     C>OCD f:\util
       This will change the current directory on the F: drive to the
       \UTIL directory, but leave you at the same place.

@cp 2
     C>OCD /PUSH /DISK f:\util
       This will change to the util directory on the F: drive.

@cp 2
     C>OCD /POP
       This will return you to the previous pushed directory.

@cp 3
     C>OCD /PUSH /POP
       This will save the current location on the stack and move you to
       the current stack top.

       This allows you to switch back and forth between two directories.

@cp 2
     C>OCD d:
       This will report the current directory on the D: drive.

@cp 2
     C>OCD /DISK 3:
       This will change to the directory which is 3 on the DirStack.

@cp 3
     C>OCD /MKDIR /CHANGE /DISK e:\newdir
       This will create a new directory on the E: drive called "NEWDIR"
       and automatically change to it.

@cp 3
     C>OCD /READ /LAST e:
       This will read a new HotDir file for drives CDE if present. If
       drives are present above E: then they will be ignored.

@cp 3
     C>OCD /READ /DRIVES cf /EXCLUDE c:\ignore
       This will read a new HotDir file for drives C and F only. The
       branch C:\IGNORE will be completely ignored.

@cp 6
     C>OCD /MKDIR /CHANGE newdir
        This instructs OCD to create the directory newdir, and then set
        it to be the default dir. If the directory was created on a
        different drive, then the default directory for that drive will
        be changed. If the /DISK option was also specified, then the
        current working disk and directory would be changed.

@cp 3
     C>OCD /UP 2
        If the current path is C:\root\sub1\sub2\sub3 this command would
        move you to C:\root\sub1

@cp 3
  Notes:
     When you specify a disk and Hot Directory, OCD will place you in
     that directory on the specified disk.

     Absolute path names are supported at all times.

     Relative path names are supported at all times.

     The DirStack depth can be set when ObsRes is installed.

@cp 4
     Hot Directory searches always start from the current location. This
     means, that if there are two (2) or more directories with the same
     match weight, then you can re-execute the same command to move along
     to the next directory.
@PA
                                DirStack
                                --------
  Description:
     Many of you may be using one of the popular alias programs available
     on the market, or using a COMMAND.COM replacement that won't support
     third party alias programs. To minimize the memory burden on systems
     that don't require the obs alias translator, you can use this small
     utility to maintain a just a DirStack.

     DirStack provides you with an optional way to configure the system
     to minimize memory usage.

  Usage:
     DIRSTACK [DirStack Depth]

  Options:
     DirStack Depth
       Specifies the number of locations to be maintained on the
       directory stack.

       Minimum depth - 1 entry.

       Maximum depth - 9 entries.

       Default depth - 9 entries.

  Note:
     DirStack does not offer nor perform alias translations. If you want
     obs aliases then use ObsRes.
@PA
SmartPaths
-----------
  The DirStack keeps track of where you've been. These places, as long as
  they are still on the stack, can be referenced by SmartPaths 1: - 9:.
  SmartPaths in a sense, act just like new drives. You can add additional
  directory specifiers to a SmartPath, but you may not address via its
  root.

  Note: ObsRes or DirStack must be installed for SmartPath operation.

  To view the directories on the DirStack type:
    C>OCD /LIST

    It will make a report like the following example:
      1: C:\DOS                      **  Top of stack   SmartPath 1: **
      2: D:\TURBO\TC\CPROGS\OBSKIT   **                 SmartPath 2: **
      3: E:\BATCH                    **                 SmartPath 3: **
      4: F:\UTIL                     ** Bottom of stack SmartPath 4: **

  Using the example DirStack above:
    C>LF 1:
       Provides a directory of C:\DOS.

    C>LF 2:..
       Provides a directory of D:\TURBO\TC\CPROGS.

    C>MF /C 2:MF.EXE 4:
       Copies file D:\TURBO\TC\CPROGS\OBSKIT\MF.EXE to F:\UTIL\MF.EXE.

  Note:
    You cannot reference the root of a SmartPath, hence 1:\ is considered
    an error.

  The real time saver of this feature is when you want to address another
  directory on the same drive. DOS will not permit this without
  SUBSTituting in a new disk, or typing the complete path name.

  Using the example DirStack above, and assuming that you are currently
  located in D:\COMM\PROC\UPLOADS, you can easily copy files from the
  D:\TURBO\TC\CPROGS\OBSKIT without typing the path. Simply typing:

    D:\COMM\PROC\UPLOADS>MF /C 2:obskit.zip

  will copy the file D:\TURBO\TC\CPROGS\OBSKIT\OBSKIT.ZIP
         to the file D:\COMM\PROC\UPLOADS\OBSKIT.ZIP

  TIP:
    Define a LIST command to report the SmartPaths on the stack.
      C>ALIAS list OCD /LIST
@PA
Quoting strings
---------------
  Occasionally you may want to provide multiple words as a single
  parameter. To do this, simply quote the string. All the data between a
  pair of double quotes will be treated as a single word.

     (e.g., "This is a Quoted string")

  When using quotes, remember one thing. Don't forget to close the
  quotes.

  To insert a quote into a quoted string, prepend each embedded quote
  with a single backslash. For example:

     "This string contains a \"Quoted string\""

  will yield

     This string contains a "Quoted string"

  Note:
     You cannot place a '\' at the end of a parameter using quotes. This
     appears to be a bug in the compilers runtime library.


ErrorLevels
-----------
  A simple, but flexible policy on DOS ErrorLevels has been consistently
  applied to all tools. The higher the error level, the more critical the
  error was to the normal operation of the tool. At the bottom, or
  errorlevel 0, is "NO ERRORs", while at the top, errorlevel 6 is an
  "INSTALL" error, where the tool was unable to execute.

  The ErrorLevels are as follows:

  0 - NO ERROR         - No error encountered
  1 - NOT FOUND        - File or object was "NOT FOUND"
  2 - ABORTED          - The user chose to "ABORT" the operation
  3 - OPERATION FAILED - The requested "OPERATION FAILED"
  4 - LIMIT EXCEEDED   - The operation exceeded the tools "LIMIT"
  5 - USAGE ERROR      - The tool displayed a "USAGE" error
  6 - INSTALL FAILED   - The tool was unable to "INSTALL"
@PA
Options
-------
   o Options may be placed on the command line in any order.

   o Options are processed from left to right.

   o Options must be separated by spaces.

   o Usually options may appear anywhere on the command line (after the
     tools name). For consistency in the examples provided, all options
     were placed before the user supplied arguments.

   o Throughout this document, options were defined in UPPER and lower
     case. The UPPER case portion is the minimum string recognized by the
     tools. The lower case is the remainder of the option name. The lower
     case portion is always optional, but if present must match.

@cp 7
Reading the Usage
-----------------
   Parameters specified between '[' & ']' are optional. Their presence is
   not required (the specific operation is dictated by the particular
   tool).

   Parameters specified between '{' & '}' are repeatable.

   Parameters separated by a '|' are one or the other.

   You do not type the above symbols!


                              Registration
                              ------------

To register this component of Obs Toolkit, fill out the order form and
mail with payment to the address specified. You have the option of
registering the entire Toolkit (highly recommended). You can select that
option on the registration form also.


Component Registration
----------------------
Individual component registration is $8.00 per component.

Upon receipt of your order for only a component of Obs Toolkit, a thank
you letter will be promptly mailed to you. If there are any serious bugs
reported in the software, you will be automatically updated at no extra
cost to you.


Toolkit Registration
--------------------
Obs Toolkit registration is $39.00

Upon receipt of your order for the entire Toolkit, a registered version
of Obs Toolkit will be promptly mailed to you. You will then be entitled
to updates at a reduced cost. If there are any serious bugs reported in
the software, you will be automatically updated at no extra cost to you.

Toolkit registration includes a registered version and a printed manual.


Technical Support
-----------------
Technical support is always available. If after one (1) hour of phone
support you are asking basic questions (answers readily available in the
documentation), then the "free" technical support will be exhausted and
will become an additional cost item.


@cp 4
Individual Use
--------------
Registration of a Toolkit component is $8.00.
Registration for the complete Toolkit is $39.00 plus shipping and handling.
California residents must pay sales tax.


@cp 6
Corporations / Institutions
---------------------------
Site licenses are not available for Toolkit components.

A license to use Obs Toolkit is required in corporations and
institutions. The license will allow duplication of the Toolkit at a
single site for the number of copies purchased. The cost of the license
is based on the number of machines on which the Toolkit will be running.

The schedule of fees is as follows:

@cp 7
                Number of copies           Price per copy
                ----------------           --------------
                          1                   $39.00
                    2 -   9                    28.00
                   10 -  24                    24.00
                   25 -  49                    21.00
                   50 - 100                    19.00

All payments must be in U.S. dollars.

@cp 3
Regardless of the quantity ordered, only one (1) manual, and one disk
containing the registered copy of the Toolkit will be mailed. Upon
receipt, you will be authorized to make as many copies of the Toolkit as
you are licensed. The printed manual may not be reproduced. Additional
printed manuals are $6.00 each.


                              Refund Policy
                              -------------

@cp 3
Each registration comes with a 30 day, no questions asked, money back
guarantee. In the event of a system incompatibility, the guarantee is
extended to a full 90 days.

@cp 3
Upon receipt of properly returned merchandise, Contrails will refund the
full purchase price of the software less shipping and handling. Contrails
will not accept items returned with insufficient postage or COD charges.

@cp 2
Before you return the Toolkit you must contact Contrails, Inc. for a
Return Authorization number. Returns will not be accepted without one.

You must return the registered disk, and manuals in good condition.


                              ASP Ombudsman
                              -------------

This program is produced by a member of the Association of Shareware
Professionals (ASP). ASP wants to make sure that the shareware principle
works for you. If you are unable to resolve a shareware-related problem
with an ASP member by contacting the member directly, ASP may be able to
help. The ASP Ombudsman can help you resolve a dispute or problem with an
ASP member, but does not provide technical support for members' products.
Please write to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442-
9427 or send a Compuserve message via CompuServe Mail to ASP Ombudsman
70007,3536"